Fix OAuth example to avoid unsupported custom basepath#5901
Open
compair-steven wants to merge 1 commit into
Open
Fix OAuth example to avoid unsupported custom basepath#5901compair-steven wants to merge 1 commit into
compair-steven wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR is intended to update the OAuth 2.0 examples in the auth setup docs to avoid using a custom basepath as the hosted documentation URL, which was explicitly addressed in PR #4387.
Because of the previous PR, the page states that auth is not supported when using a custom basepath such as
example.com/docs, but the OAuth example currently usesfoo.com/docsas the docs URL. This could make the OAuth setup appear supported for deployment in a way that the same page says is unsupported.Documentation Changes
foo.com/docstodocs.foo.comreturnTovalue in the Logout URLNotes
This is a documentation-only consistency fix. I left the
api.foo.com/docs/user-infoexample unchanged because that appears to be an application/API endpoint path, not the hosted Mintlify docs path.For Reviewers
When reviewing documentation PRs, please consider:
✅ Technical accuracy
✅ Clarity and completeness
✅ User experience
Note
Low Risk
Low risk documentation-only edits; changes are limited to example URLs and minor formatting/newline fixes.
Overview
Aligns the OAuth 2.0 example in
authentication-setup.mdx(EN/ES/FR/ZH) with the documented restriction that authentication is not supported on custom basepaths by switching the sample docs URL fromfoo.com/docstodocs.foo.com.Updates the example
Logout URLreturnTovalue accordingly, and normalizes the final table row/newline at EOF in translated pages.Reviewed by Cursor Bugbot for commit 1293fb8. Bugbot is set up for automated code reviews on this repo. Configure here.